Vcenter Guest Domain

Vcenter Guest Domain

Vcenter Guest Domain

The Vcenter Guest Domain schema specifies the information needed to join a workgroup or domain. This structure maps to the Identification key in the sysprep.xml answer file. These values are transferred into the sysprep.xml file that VirtualCenter stores on the target virtual disk. For more information about performing unattended installation, check https://technet.microsoft.com/en-us/library/cc771830(v=ws.10).aspx

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "type": "string",
    "workgroup": "string",
    "domain": "string",
    "domain_username": "string",
    "domain_password": "string",
    "domain_ou": "string"
}

string

type

Required

The type of network to join after the customization.

For more information see: Vcenter Guest Domain Type.

This property was added in vSphere API 7.0.0.0.

string

workgroup

Optional

The workgroup that the virtual machine should join.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of type is Vcenter Guest Domain Type.WORKGROUP.

string

domain

Optional

The domain to which the virtual machine should be joined.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of type is Vcenter Guest Domain Type.DOMAIN.

string

domain_username

Optional

The domain user that has permission to join the domain after virtual machine is joined.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of type is Vcenter Guest Domain Type.DOMAIN.

string As password As password

domain_password

Optional

The domain user password that has permission to join the Vcenter Guest Domain.domain_username after customization.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of type is Vcenter Guest Domain Type.DOMAIN.

string

domain_ou

Optional

The MachineObjectOU which specifies the full LDAP path name of the OU to which the virtual machine belongs. Refer to: https://docs.microsoft.com/en-us/windows-hardware/customize desktop/unattend/microsoft-windows-unattendedjoin- identification-machineobjectou

This property was added in vSphere API 8.0.2.0.

This property is optional and it is only relevant when the value of type is Vcenter Guest Domain Type.DOMAIN.